home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / tv321.zip / TVAULT.DOC < prev    next >
Text File  |  1993-03-22  |  22KB  |  725 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                                      ----------------------
  8.                                                        T i m e  V a u l t
  9.                                                      ----------------------
  10.                                                     a time banking door for
  11.                                              Searchlight BBS 2.0 and higher
  12.  
  13.                                                                 version 3.2
  14.                                             Copyright (c) 1989,93 Jim Barry
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                                Table of Contents
  70.                                -----------------
  71.  
  72.      Introduction .................................................. 2
  73.  
  74.      Registration Information ...................................... 2
  75.  
  76.      Setup & Installation .......................................... 3
  77.  
  78.      Advanced Options/Extra Features ............................... 4
  79.        Deposit .................................................. 4
  80.        Withdraw ................................................. 4
  81.        TVAULT.CFG ............................................... 5
  82.        Transfer ................................................. 6
  83.        Goodbye .................................................. 6
  84.        Sysop Utilities .......................................... 6
  85.        2-Sysop .................................................. 7
  86.  
  87.      Sample Command Lines .......................................... 7
  88.  
  89.      Local Status Line ............................................. 8
  90.  
  91.      TVAULT.LOG Activity Log File .................................. 8
  92.  
  93.      Sysop Chat Mode ............................................... 8
  94.  
  95.      DesqView(tm) Aware ............................................ 8
  96.  
  97.      TVAULT.SL2 Data File .......................................... 9
  98.  
  99.      Acknowledgments .............................................. 10
  100.  
  101.      Disclaimer ................................................... 10
  102.  
  103.      Footnote ..................................................... 10
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                      - 1 -
  130.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  131.  
  132.  
  133.  
  134.  
  135.      ------------
  136.      Introduction
  137.      ------------
  138.  
  139.      Time Vault is a professional quality, utility/game door written for
  140.   Searchlight bulletin board software, Version 2.0 and up.  The original
  141.   version was released in 1989 and has benn constantly undergoing revisions
  142.   and upgrades.  The current version is loaded with many features and we
  143.   feel this is one of the best utility door programs available for
  144.   Searchlight BBS.
  145.  
  146.      Here is a listing of major features offered by Time Vault:
  147.  
  148.        1.  Allows users to store system time and withdraw at a later date.
  149.        2.  Blends into Searchlight by utilitizing the same look and feel.
  150.        3.  Color choices are from your Searchlight configuration.
  151.        4.  Transfer feature to give time to a different user. (option)
  152.        5.  Local status line with ALT/F-key support.
  153.        6.  Goodbye feature to allow BBS logoff via door. (option)
  154.        7.  Configure maximum balances/withdrawals via access levels using a
  155.            text file. (option)
  156.        8.  Scans EVENT.DEF file to ensure Time Vault withdrawals do not
  157.            interfere with an upcoming event.
  158.        9.  Sysop chat mode just like Searchlight's.
  159.       10.  Sysop Utility feature allowing Sysops to modify user account
  160.            balances and print listings of the vault file.
  161.       11.  Activity log of all Time Vault transactions.
  162.  
  163.  
  164.      ------------
  165.      Registration
  166.      ------------
  167.  
  168.      Time Vault is distributed as 'shareware' and continued use after an
  169.   acceptable trial period requires a registration fee.  The trial period
  170.   is 21 days (3 weeks), after which, a registration fee must be paid to
  171.   the author.  If you fail to register after the 21 day trial period,
  172.   you MUST discontinue use of the software.  The only way shareware
  173.   authors are compensated for their efforts is through registrations.
  174.   Please support the shareware marketing concept and encourage authors
  175.   to produce updates, as well as new shareware programs.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                      - 2 -
  196.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  197.  
  198.  
  199.  
  200.  
  201.      ------------------
  202.      Setup/Installation
  203.      ------------------
  204.  
  205.      The following files should be contained within this ZIP archive:
  206.  
  207.        TVAULT  .DOC  -  Time Vault documentation file
  208.        TVAULT  .EXE  -  The actual Time Vault program file
  209.        REVISION.TXT  -  Update information on Time Vault
  210.        TV-ORDER.FRM  -  Order form for registering
  211.  
  212.      (If any of these files are missing, please ask the sysop of the BBS
  213.       from which you obtained it to remove the archive from his system.)
  214.  
  215.  
  216.      Because Time Vault is designed specifically for Searchlight BBS, it is
  217.   one of the easiest programs to setup.  Please follow these easy steps:
  218.  
  219.  
  220.      Place the TVAULT.EXE file somewhere on your hard drive.  We suggest
  221.   your main BBS directory.  The same directory that you keep BBS.EXE,
  222.   FILE.EXE, etc, in.
  223.  
  224.  
  225.      Next, make an entry in your DOORS.DEF file.  Follow the format of the
  226.   one below.
  227.  
  228.           2;0;1;30;Time Vault - Store Time;.;C:\BBS\TVAULT.EXE
  229.           | | | |           |              |        |
  230.           a b c d           e              f        g
  231.  
  232.        a) Tells Searchlight to provide communications support.  Set this to
  233.           a (2), telling Searchlight to send color to the remote user even
  234.           if the local BBS computer is monochrome.
  235.  
  236.        b) Disk-drive write protection during door.  This must be set to a
  237.           (0) to allow Time Vault to write it's information.
  238.  
  239.        c) Action on carrier loss.  Set this to a (1), telling Searchlight
  240.           to terminate the door program if the carrier is dropped during
  241.           door execution.
  242.  
  243.        d) BBS access level required to use door.
  244.  
  245.        e) Description of door displayed to your users.
  246.  
  247.        f) Directory to switch to before executing door.  This should ALWAYS
  248.           be set to a PERIOD ONLY, as it is above.  Time Vault looks in the
  249.           current directory only when trying to read the CONFIG.SL2 file.
  250.           Making this a PERIOD will ensure that the correct CONFIG.SL2 file
  251.           is always found.
  252.  
  253.        g) The full path and filename of the TVAULT.EXE file.
  254.  
  255.  
  256.      If you have additional DOOR.DEF files for other nodes, make identical
  257.   entries in those.
  258.  
  259.  
  260.  
  261.                                      - 3 -
  262.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  263.  
  264.  
  265.  
  266.  
  267.      That's it.  You've installed Time Vault, with the basic, default
  268.   configuration.  Not too tough, eh?  The basic installation allows:
  269.  
  270.      - maximum account balance of 60 minutes.
  271.      - maximum daily balance of 30 minutes.
  272.      - "Deposit", "Withdraw" and "Quit" menu options.
  273.  
  274.      To customize this installation, as well as activating extra options,
  275.   please see the next section.
  276.  
  277.  
  278.      -------------------------------
  279.      Advanced Options/Extra Features
  280.      -------------------------------
  281.  
  282.      Time Vault, without any additional command line switches, will operate
  283.   just fine.  However, there are several options that can be enabled.  The
  284.   format for running Time Vault with these options is:
  285.  
  286.               TVAULT.EXE -[option-1] ... -[option-n]
  287.  
  288.  
  289.   ** DEPOSIT **
  290.  
  291.      The [DEPOSIT] command allows your users to store a maximum of anywhere
  292.   between 0 and 32767 minutes in their 'account.'  By default, the maximum
  293.   balance is set to 60 minutes.
  294.  
  295.      To allow users to store MORE (or less) time, you can run Time Vault
  296.   with the '-MB=' paramemter.  To allow users to store 500 minutes of time,
  297.   you would run Time Vault with this command line:
  298.  
  299.      TVAULT.EXE -MB=500
  300.  
  301.      This would now allow account balances of 500 minutes.  See the section
  302.   on the TVAULT.CFG file for another configuration option of maximum
  303.   balances.
  304.  
  305.  
  306.   ** WITHDRAW **
  307.  
  308.      The [WITHDRAW] command allows your users to take time out of their
  309.   account.  By default, the user can remove 30 minutes/day.  The range of
  310.   daily withdrawal values is 0-1440 minutes.  A maximum withdrawal of 0
  311.   disables the daily withdrawal limit.
  312.  
  313.      To allow users to withdraw more than 30 minutes/day, you can use the
  314.   '-MW=' command line switch.  If you wanted to allow your users to
  315.   withdraw up to 200 minutes/day, run Time Vault with this command line:
  316.  
  317.      TVAULT.EXE -MW=200
  318.  
  319.      This would now allow daily withdrawals of 200 minutes.  See the
  320.   section on the TVAULT.CFG file for another configuration method of
  321.   maximum withdraws.
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                      - 4 -
  328.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  329.  
  330.  
  331.  
  332.  
  333.   ** TVAULT.CFG File **
  334.  
  335.      The TVAULT.CFG file gives the sysop the ability of assigning maximum
  336.   balance and maximum daily withdrawal limits based on the users access
  337.   level.  By doing this, you may give higher level users the ability to
  338.   store or withdraw more time than lower level users.
  339.  
  340.      When Time Vault is trying to determine what the settings of maximum
  341.   balances and maximum daily withdrawals is, it performs the following
  342.   steps:
  343.  
  344.      1) Looks in the current nodes CONFIG.SL2 directory for TVAULT.CFG
  345.      2) Looks in the main data directory for TVAULT.CFG
  346.      3) Looks at the TVAULT.EXE command line for switches
  347.      4) Uses internal defaults
  348.  
  349.      On a single node system, place the TVAULT.CFG file into your main data
  350.   directory.
  351.  
  352.      If you operate a multinode system, the TVAULT.CFG file can reside in 1
  353.   of 2 places.  You can place it into your CONFIG.SL2 directory.  If you
  354.   put it here, the TVAULT.CFG file becomes specific to that node only.  Or,
  355.   you can place it into your main data directory, making that configuration
  356.   file global to all nodes.
  357.  
  358.      The format of the TVAULT.CFG file very simple.  You can create the
  359.   file using any text editor program.  Even use Searchlight's built in
  360.   editor if you like.  The file should be laid out as follows:
  361.  
  362.      {access level} = {maximum balance};{maximum daily withdrawal}
  363.  
  364.      This file may contain as many lines as necessary.  When Time Vault
  365.   reads this file, it attempts to match a listed access level that is less
  366.   than or equal to the current user's access level.
  367.  
  368.      Here is a sample TVAULT.CFG file:
  369.  
  370.      10 = 30;15
  371.      50 = 60;60
  372.      100 = 120;0
  373.  
  374.      Now, if a user runs Time Vault, this is what his maximum withdrawal
  375.   and maximum balance settings will be:
  376.  
  377.      User Access     Maximum Balance     Maximum Withdrawal
  378.         10               30 minutes           15 minutes
  379.         50               60   "               60   "
  380.         20               30   "               15   "
  381.          5                0   "              (no limit)
  382.        150              120   "              (no limit)
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                      - 5 -
  394.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  395.  
  396.  
  397.  
  398.  
  399.   ** TRANSFER **
  400.  
  401.      The [TRANSFER] option allows users to trade time with other users.
  402.   It's a very simple feature to operate.  By default, this option is not
  403.   available to your users, however, it can be enabled using the '-T'
  404.   command line switch like this:
  405.  
  406.      TVAULT.EXE -T
  407.  
  408.      A user can only transfer time that is _IN_ their account.  The maximum
  409.   a user can transfer is equal to their account balance.  The amount they
  410.   can transfer to a specific user is determined by that users current
  411.   balance and the maximum balance limit of the user doing the transfering.
  412.  
  413.      For example, if Suzie Snowflake attempts to transfer time to user Joe
  414.   Blow and Suzie has 60 minutes in her account.  Joe has 15 minutes in his
  415.   account.  Suzie's maximum balance is 60 minutes.  Suzie's maximum balance
  416.   limit is applied to Joe's account.  So, a maximum balance of 60 minutes
  417.   minus Joe's current balance of 15 leaves 45.  Therefore, Suzie can
  418.   transfer a maximum of 45 minutes to Joe Blow.
  419.  
  420.      It is a simple, straightforward function.  You may want to try it out
  421.   yourself before deciding whether of not to let your users use it.
  422.  
  423.  
  424.   ** GOODBYE **
  425.  
  426.      The optional [GOODBYE] command does just what you probably think.  It
  427.   logs the user off your BBS directly from the door program.  This command
  428.   can be activated by running Time Vault with the "-G" command as follows:
  429.  
  430.      TVAULT.EXE -G
  431.  
  432.      When a user selects this function, they are given an "Are you sure?"
  433.   question to confirm that they wish to logoff.  If they choose Yes, the
  434.   door will terminate and look like it is returning to the BBS as normal.
  435.   HOWEVER, when the BBS reloads, it thinks it just ran the auto-LOGOFF
  436.   door, and will immediately display your LOGOFF.TXT/ANS file and hangup.
  437.  
  438.      The only drawback of this command is that, when used, your auto-logoff
  439.   door does not get run.
  440.  
  441.  
  442.   ** SYSOP UTILITY **
  443.  
  444.      Time Vault has a Sysop Utility mode built into the program.  Getting
  445.   to this special utility menu can be done by one of three methods:
  446.  
  447.      1) Run the door as a user with 254 or 255 access.
  448.      2) Toggle the superuser flag and run the door.
  449.      3) Run Time Vault with the '-S' command line switch.
  450.  
  451.      The Utility menu has 3 options; [EDIT], [LIST], and [QUIT].
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                      - 6 -
  460.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  461.  
  462.  
  463.  
  464.  
  465.      The [EDIT] command prompts you for a username (or partial user name)
  466.   to select.  Once a user is selected, that users account information is
  467.   displayed.  The balance of their account can be edited.  As the sysop,
  468.   you can set the balance anywhere from 0 to the maximum of 32767.  You are
  469.   not limited to the settings on the command line or in the TVAULT.CFG
  470.   file.
  471.  
  472.      The [LIST] command allows you to display account information of your
  473.   users in a table format.  The information is displayed as "Balance",
  474.   "User Name", and "Last Transaction".  The listing can be aborted by
  475.   hitting the spacebar or control-C at anytime.
  476.  
  477.      Available in the REGISTERED VERSION of Time Vault--  You can choose to
  478.   output the information to either the screen, or to a file or DOS device.
  479.   If you choose "File/Print", you will be prompted to enter the output
  480.   filename.  To send the list to a disk file enter a filename.  If you want
  481.   the list sent to a printer or other DOS device, enter as "LPT1", "PRN",
  482.   etc.  The unregistered version only allows printing to the screen.
  483.  
  484.  
  485.   ** 2-SYSOP **
  486.  
  487.      I lied.  There is a 4th way to execute the Sysop Utility menu.  If a
  488.   user is currently running Time Vault and you want to get to the Sysop
  489.   Menu, turn on the superuser flag (ALT-S).  The NEXT time the Time Vault
  490.   menu is displayed, the [2-SYSOP] command will appear.  Choosing this
  491.   option will take you to the Time Vault Sysop Utility menu.
  492.  
  493.  
  494.      --------------------
  495.      Sample Command Lines
  496.      --------------------
  497.  
  498.   TVAULT.EXE -MB=1000 -G
  499.      Executes Time Vault with Deposit, Withdrawal, Goodbye and Quit options
  500.   active.  The maximum balance is set to 1000 minutes.  The maximum
  501.   withdrawal is set to 30 minutes (the default).
  502.  
  503.   TVAULT.EXE
  504.      Executes Time Vault with the Deposit, Withdraw, and Quit options
  505.   active.  Maximum balance is set to 60 minutes, Maximum withdrawal set to
  506.   30. (both defaults)
  507.  
  508.   TVAULT.EXE -T -G -MB=500 -MW=100
  509.      Executes Time Vault with Deposit, Withdraw, Transfer, Goodbye, and
  510.   Quit options active.  Maximum balance is set to 500 minutes.  Maximum
  511.   withdrawal is set to 100 minutes/day.
  512.  
  513.   TVAULT.EXE -S
  514.      Executes Time Vault in Sysop Utility mode.
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.                                      - 7 -
  526.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  527.  
  528.  
  529.  
  530.  
  531.      -----------------
  532.      Local Status Line
  533.      -----------------
  534.  
  535.      Time Vault displays a local status line, which is always active.  It
  536.   looks and acts very much like the Searchlight status line.  Several hot-
  537.   keys are available in relationship to the status line:
  538.  
  539.      ALT-A  - toggles the sysop availability flag
  540.      ALT-S  - toggles the super user access flag
  541.      ALT-N  - toggles the sysop next flag
  542.      F8     - Toggles user information in the status line
  543.      F9     - Increases users current session time limit in 5
  544.                 minute intervals
  545.      F10    - Decreases users current session time limit in 5
  546.                 minute intervals
  547.  
  548.  
  549.      -----------------
  550.      Activity Log File
  551.      -----------------
  552.  
  553.      Time Vault automatically generates an activity log file when run.  The
  554.   activity log, called TVAULT.LOG, is placed into the main BBS directory.
  555.   There is only 1 log file for all nodes in a multi-user setup.  The
  556.   entries are in the following format:
  557.  
  558.      {date} {time}  {username} {action} {number of minutes}
  559.  
  560.      For example:
  561.  
  562.      08/28/91 09:42  SUZIE SNOWFLAKE withdrew 20 minutes
  563.  
  564.      All Deposits, Withdrawals, and Transfers are logged.
  565.  
  566.  
  567.      ---------------
  568.      Sysop Chat Mode
  569.      ---------------
  570.  
  571.      At anytime during program execution, the sysop can enter chat mode
  572.   with the user on-line by pressing <ALT-C> on the local computer keyboard.
  573.   This chat mode operates and feels just like the Searchlight chat mode.
  574.   In fact, it so much like SL, you and your users may even forget that you
  575.   are in a door and not Searchlight.
  576.  
  577.      Hitting the <Escape> key on the local keyboard will exit chat mode.
  578.   Program execution will then resume at the exact point at which you
  579.   interrupted it.
  580.  
  581.  
  582.      ------------------
  583.      DesqView(tm) Aware
  584.      ------------------
  585.  
  586.      Time Vault is DesqView aware to allow it to make the most efficient
  587.   use of your computers processor time.  This is done by passing extra time
  588.   back to other tasks when it is waiting for input.  Of course, you only
  589.   benefit from this feature is you run DesqView.
  590.  
  591.                                      - 8 -
  592.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  593.  
  594.  
  595.  
  596.  
  597.      --------------------
  598.      TVAULT.SL2 Data File
  599.      --------------------
  600.  
  601.      The data file Time Vault uses to track users accounts is called
  602.   TVAULT.SL2.  This file is automatically created in the BBS data
  603.   directory.  This file is in binary format and cannot be changed with a
  604.   text editor, etc.
  605.  
  606.      If you are trying to write some utility to work with the Time Vault
  607.   data file, here is the structure in Turbo Pascal:
  608.  
  609.  
  610.   Type transacttype = (DEPOSIT, WITHDRAW, NEW, TRANSFER);
  611.  
  612.        datetype = record
  613.          year: byte;
  614.          month: byte;
  615.          day: byte;
  616.        end;
  617.  
  618.        vaulttype = record
  619.          name       : string[25];   { users name }
  620.          balance    : integer;      { account balance }
  621.          withtoday  : integer;      { amount withdrawn today }
  622.          lastwith   : datetype;     { date of last withdrawal }
  623.          lasttran   : datetype;     { date of last transaction }
  624.          lastamount : integer;      { amount of last transaction }
  625.          lasttype   : transacttype; { type of last transaction}
  626.          xtra       : string[5];    { extra space }
  627.        end;
  628.  
  629.  
  630.        The TVAULT.SL2 file is a "File of vaulttype".  The record number of
  631.   users vault account is the same as the users record number in the
  632.   USER.SL2 file.
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.                                      - 9 -
  658.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  659.  
  660.  
  661.  
  662.  
  663.      ---------------
  664.      Acknowledgments
  665.      ---------------
  666.  
  667.      The following people/organizations deserve special mention:
  668.  
  669.      - Frank LaRosa & Tim Rossiter, authors of Searchlight BBS of which
  670.          without, Time Vault would have no purpose.
  671.      - Gregg Flagg, motivated me to write a time bank door for Searchlight,
  672.          as well as coming up with the name "Time Vault".
  673.      - Chris Costakis, for just being an annoying pest to get me to write a
  674.          version of Time Vault for the Shareware Searchlight.  And THEN he
  675.          switches to the extended version a week later.
  676.      - Borland International, for providing the world with Turbo Pascal,
  677.          which Time Vault is written in.
  678.      - All original Cleveland area beta-testers.  Thanks for finding most
  679.          of my stupid mistakes, guys!
  680.  
  681.  
  682.      ----------
  683.      Disclaimer
  684.      ----------
  685.  
  686.      I have tested this program to the best of my abilities and believe it
  687.   to be void of any and all bugs.  I attest that when I released this
  688.   program, there were no "undocumented" features herein.  I give no
  689.   warrantees or guarantees as to the correct operation of this software.  I
  690.   will not be liable for any incidental or consequential damages as a result
  691.   of the use of this software.
  692.  
  693.      Your use of the software confirms your acceptance to the statements in
  694.   this disclaimer.
  695.  
  696.  
  697.      --------
  698.      Footnote
  699.      --------
  700.  
  701.      Comments, Suggestions, and Registrations may be mailed to:
  702.  
  703.             Jim Barry
  704.             PO Box 35487
  705.             Cleveland, OH  44135-0487
  706.  
  707.      And if your really in the mood to get in touch with me, (or at least
  708.   the latest release of Time Vault), you can call my BBS:
  709.  
  710.             Flip Flop BBS  [4 lines]
  711.             (216) 951-9150   3-2400 Baud
  712.             (216) 951-9134   14.4k Baud v.32bis
  713.  
  714.      And remember:  When a program has no bugs...  It's obsolete!
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.                                      - 10 -
  723.               Time Vault v3.2, (c) Copyright 1989,93 Jim Barry
  724.  
  725.